Create a new equipment config

Only one equipment config is associated with a shipment at a time. Posting here will overwrite the previous equipment config and attempt to track with the new configuration.

SecurityAuthToken
Request
path Parameters
shipmentId
required
string <uuid>

The id of the shipment

Request Body schema: application/json
required
carrier
string or null <uuid>
created_at
string or null <date-time>
object (Driver)
driver_pin
integer or null <int32>
id
string or null <uuid>
power_unit
string or null <uuid>
power_unit_name
string or null
trailer
string or null <uuid>
trailer_name
string or null
updated_at
string or null
Responses
201

Successfully created an EquipmentConfig

Response Schema: application/json
object (Carrier)
created_at
string or null <date-time>
object (Driver)
driver_pin
integer or null <int32>
id
string or null <uuid>
object (PowerUnit)
object (Trailer)
updated_at
string or null <date-time>
default

Default error response

post/shipments/{shipmentId}/equipment-config/
Request samples
application/json
{
  • "carrier": "faaa07f8-ed24-4408-95d3-1d7233f61a3e",
  • "created_at": "2019-08-24T14:15:22Z",
  • "driver": {
    },
  • "driver_pin": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "power_unit": "f27741aa-8f6d-407f-bff2-b2e6e3af2fd2",
  • "power_unit_name": "string",
  • "trailer": "05fcacec-cb57-447b-8b7f-e082eeb81d8d",
  • "trailer_name": "string",
  • "updated_at": "string"
}
Response samples
application/json
{
  • "carrier": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "driver": {
    },
  • "driver_pin": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "power_unit": {
    },
  • "trailer": {
    },
  • "updated_at": "2019-08-24T14:15:22Z"
}
Copyright © Shipwell 2024. All right reserved.